Fix roxygen2 8.0.0 link-resolution warnings#73
Open
schloerke wants to merge 1 commit into
Open
Conversation
Several @nord functions (steps, reduce_steps, along_builder, iter_adapt, etc.) were referenced via markdown links, which roxygen2 8.0.0 now flags since no Rd topic exists for unexported/undocumented functions. Convert these to plain code spans instead of links.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Updated documentation with the latest roxygen2 (8.0.0) via
devtools::document(), which surfaced 14 new "Could not resolve link to topic" warnings. These were all markdown links (e.g.[steps],[reduce_steps()],[iter_adapt()]) pointing at internal helper functions documented with@noRd, so no Rd topic exists for roxygen2 to link to. Replaced these links with plain code spans inR/iterator-adapt.R,R/step-builder.R,R/step-reduce.R, andR/step.R.DESCRIPTIONandman/coro-package.Rdwere regenerated as a side effect of running the newer roxygen2/devtools (addsConfig/roxygen2/versionand expands the authors list in the package Rd).Verification
Ran
devtools::document()before and after: previously produced 14 warnings, now completes with zero warnings.